home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / JFC.bin / CharStream.java < prev    next >
Text File  |  1998-06-30  |  5KB  |  130 lines
  1. /* Generated By:JavaCC: Do not edit this line. CharStream.java Version 0.7pre6 */
  2. /*
  3.  * @(#)CharStream.java    1.3 98/03/12
  4.  * 
  5.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  6.  * 
  7.  * This software is the confidential and proprietary information of Sun
  8.  * Microsystems, Inc. ("Confidential Information").  You shall not
  9.  * disclose such Confidential Information and shall use it only in
  10.  * accordance with the terms of the license agreement you entered into
  11.  * with Sun.
  12.  * 
  13.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  14.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  15.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  16.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  17.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  18.  * THIS SOFTWARE OR ITS DERIVATIVES.
  19.  * 
  20.  */
  21. package com.sun.java.swing.text.html;
  22.  
  23. /**
  24.  * This interface describes a character stream that maintains line and
  25.  * column number positions of the characters.  It also has the capability
  26.  * to backup the stream to some extent.  An implementation of this
  27.  * interface is used in the TokenManager implementation generated by
  28.  * JavaCCParser.
  29.  *
  30.  * All the methods except backup can be implemented in any fashion. backup
  31.  * needs to be implemented correctly for the correct operation of the lexer.
  32.  * Rest of the methods are all used to get information like line number,
  33.  * column number and the String that constitutes a token and are not used
  34.  * by the lexer. Hence their implementation won't affect the generated lexer's
  35.  * operation.
  36.  */
  37.  
  38. abstract interface CharStream {
  39.  
  40.   /**
  41.    * Returns the next character from the selected input.  The method
  42.    * of selecting the input is the responsibility of the class
  43.    * implementing this interface.  Can throw any java.io.IOException.
  44.    */
  45.   abstract public char readChar() throws java.io.IOException;
  46.  
  47.   /**
  48.    * Returns the column position of the character last read.
  49.    * @deprecated 
  50.    * @see #getEndColumn
  51.    */
  52.   abstract public int getColumn();
  53.  
  54.   /**
  55.    * Returns the line number of the character last read.
  56.    * @deprecated 
  57.    * @see #getEndLine
  58.    */
  59.   abstract public int getLine();
  60.  
  61.   /**
  62.    * Returns the column number of the last character for current token (being
  63.    * matched after the last call to BeginTOken).
  64.    */
  65.   abstract public int getEndColumn();
  66.  
  67.   /**
  68.    * Returns the line number of the last character for current token (being
  69.    * matched after the last call to BeginTOken).
  70.    */
  71.   abstract public int getEndLine();
  72.  
  73.   /**
  74.    * Returns the column number of the first character for current token (being
  75.    * matched after the last call to BeginTOken).
  76.    */
  77.   abstract public int getBeginColumn();
  78.  
  79.   /**
  80.    * Returns the line number of the first character for current token (being
  81.    * matched after the last call to BeginTOken).
  82.    */
  83.   abstract public int getBeginLine();
  84.  
  85.   /**
  86.    * Backs up the input stream by amount steps. Lexer calls this method if it
  87.    * had already read some characters, but could not use them to match a
  88.    * (longer) token. So, they will be used again as the prefix of the next
  89.    * token and it is the implemetation's responsibility to do this right.
  90.    */
  91.   abstract public void backup(int amount);
  92.  
  93.   /**
  94.    * Returns the next character that marks the beginning of the next token.
  95.    * All characters must remain in the buffer between two successive calls
  96.    * to this method to implement backup correctly.
  97.    */
  98.   abstract public char BeginToken() throws java.io.IOException;
  99.  
  100.   /**
  101.    * Returns a string made up of characters from the marked token beginning 
  102.    * to the current buffer position. Implementations have the choice of returning
  103.    * anything that they want to. For example, for efficiency, one might decide
  104.    * to just return null, which is a valid implementation.
  105.    */
  106.   abstract public String GetImage();
  107.  
  108.   /**
  109.    * Returns an array of characters that make up the suffix of length 'len' for
  110.    * the currently matched token. This is used to build up the matched string
  111.    * for use in actions in the case of MORE. A simple and inefficient
  112.    * implementation of this is as follows :
  113.    *
  114.    *   {
  115.    *      String t = GetImage();
  116.    *      return t.substring(t.length() - len, t.length()).toCharArray();
  117.    *   }
  118.    */
  119.   abstract public char[] GetSuffix(int len);
  120.  
  121.   /**
  122.    * The lexer calls this function to indicate that it is done with the stream
  123.    * and hence implementations can free any resources held by this class.
  124.    * Again, the body of this function can be just empty and it will not
  125.    * affect the lexer's operation.
  126.    */
  127.   abstract public void Done();
  128.  
  129. }
  130.